<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
  <head>
    <title>Stack README</title>
  </head>

  <body>
<center>
<h1> ReadMe</h1>
<a href="gy@hawaii.edu">Guanghong Yang</a> &amp; <a href="olkov@hawaii.edu">Alexey Olkov</a> <br>
<A HREF="http://www.hawaii.edu/">University of Hawaii<br>
</A>
<p>
</center>

This file introduces you to the
major components of this software package. It includes information on the
contents of the package you have downloaded, instructions on how to install the
system, basic invocation and usage, user documentation, developer documentation,
and contact coordinates for further information.</p>


<h2>A. Contents of this package</h2>
<table width="735" border="1">
<tr><th align="center" valign="top" width="93">Directory/File <th valign="top" width="626">Contents
<tr><td align="center" valign="top" width="93">.
    <td valign="top" width="626"> Top-level directory files include::
    <ul>
    <li> README.html (this document)
    </ul>
<tr>
  <td align="center" valign="top" width="93">./config
    <td valign="top" width="626">Contains configuration files used for simulation operations.
<tr>
  <td align="center" valign="top" width="93">./doc
    <td valign="top" width="626">Contains developer documentation including:
      <ul>
        <li><a href="doc/LicenseInfo.html">LicenseInfo.html</a> provides
          licenses for use of all software included with this system.</li>
        <li><a href="doc/History.html">History.html</a> provides a chronological
          record of the releases of this system.</li>
  </ul></tr>

<tr><td align="center" valign="top" width="93">./src
    <td valign="top" width="626">Contains the source files.
<tr>
  <td align="center" valign="top" width="93">./test
    <td valign="top" width="626">Contains ant build files for testing purposes. 
<tr>
  <td align="center" valign="top" width="93">./bin
  <td valign="top"><p>Contains binary executable file:</p>
    <ul>
    <li> TraffoSim.exe
    </ul>
<tr>
  <td width="93" align="center" valign="top">./lib
  <td valign="top">Contains required libraries (jar files). 
</table>

<h2>B. Basic Installation</h2>

<p>These instructions assume that you have unzipped the zip file containing this
system to create a directory containing the system components. A note to Unix
users: due to a bug in java.util.zip, the directory permissions are munged if you unzip in Unix, and you won't be able to cd into
interior directories.&nbsp; To fix this, invoke the following from the parent
directory of this system: chmod -R a+x &lt;system directory&gt;.&nbsp;</p>

<h3>B1: Install Java 1.5</h3>

  <ul>
    <li>Install the Java JDK (the full JDK, not just the JRE) by following the
      instructions at <a href="http://java.sun.com">http://java.sun.com</a>.</li>
    <li>Set the JAVA_HOME environment variable to point to your Java
      installation (for example, <a href="file:///c:/java/jdk1.5.0_08">c:\java\jdk1.5.0_08</a>)</li>
    <li>Add JAVA_HOME/bin to your PATH variable.&nbsp;</li>
  </ul>
  <h3>B2: Install Ant 1.7</h3>
  <ul>
    <li>Download and unzip apache-ant-1.7.0Beta1.zip (or later) from <a href="http://ant.apache.org/">http://ant.apache.org/</a>.&nbsp;</li>
    <li>Set the ANT_HOME environment variable to point to your Ant installation
      (for example, <a href="file:///c:/apache-ant-1.7.0Beta1">c:\apache-ant-1.7.0Beta1</a>)</li>
    <li>Add ANT_HOME/bin to your PATH variable.&nbsp;</li>
  </ul>
  <h3>B3: Install JUnit 4.1 </h3>
  <ul>
    <li>Download and unzip junit-4.1.zip from <A href="http://www.junit.org/index.htm">http://www.junit.org/index.htm</A><a href="http://httpunit.sourceforge.net/"></a>.&nbsp;&nbsp;</li>
    <li>Set the JUNIT_HOME environment variable to point to your JUnit
      installation (for example, <a href="file:///c:/java/httpunit-1.6.2">c:\java\junit-4.1</a>)</li>
  </ul>
  <h3>B4: Install Abbot</h3>
  <ul>
    <li>Download and unzip Abbott-1.0.0.zip from <a href="http://sourceforge.net/projects/abbot">http://sourceforge.net/projects/abbot</a>.</li>
  </ul>
  <h2>C. Invocation</h2>

  <h3>C1: Basic compilation</h3>
  <p>To perform a test, invoke &quot;ant&quot;:</p>
  <pre>C:\svn-csdl\traffosim/test&gt;ant
Buildfile: build.xml</pre>
  <pre>compile:
    [mkdir] Created dir: C:\svn-csdl\traffosim\build\war\WEB-INF\classes
    [javac] Compiling 12 source files to C:\svn-csdl\traffosim\build\war\WEB-INF\classes</pre>
  <pre>BUILD SUCCESSFUL
Total time: 5 seconds
<a href="file:///C:/svn-csdl/StackMVC">C:\svn-csdl\traffosim</a>&gt;</pre>
  <h3>C2: Running JUnit Tests</h3>
  <p>To run the JUnit tests over the system, invoke 'ant -f junit.build.xml'.
  The results should look as follows:</p>
  <pre>C:\svn-csdl\traffosim&gt;ant -f junit.build.xml
Buildfile: junit.build.xml</pre>
  <pre>compile:</pre>
  <pre>junit.tool:
    [mkdir] Created dir: C:\svn-csdl\traffosim\build\junit
    [junit] Running edu.hawaii.traffosim.control.command.TestClearCommand
    [junit] Tests run: 1, Failures: 0, Errors: 0, Time elapsed: 2.25 sec
    [junit] Running edu.hawaii.traffosim.control.command.TestPopCommand
    [junit] Tests run: 2, Failures: 0, Errors: 0, Time elapsed: 0.125 sec
    [junit] Running edu.hawaii.traffosim.control.command.TestPushCommand
    [junit] Tests run: 1, Failures: 0, Errors: 0, Time elapsed: 0.047 sec</pre>
  <pre>junit.report:
[junitreport] Processing C:\svn-csdl\traffosim\build\junit\TESTS-TestSuites.xml to C:\DOCUME~1\johnson\LOCALS~1\Temp\null1281158788
[junitreport] Loading stylesheet jar:file:/C:/apache-ant-1.7.0Beta1/lib/ant-junit.jar!/org/apache/tools/ant/taskdefs/optional/junit/xsl/junit-frames.xsl
[junitreport] Transform time: 1031ms
[junitreport] Deleting: C:\DOCUME~1\johnson\LOCALS~1\Temp\null1281158788</pre>
  <pre>junit.sensor:
[hacky-junit] Hackystat data on 4 JUnit tests sent to http://hackystat.ics.hawaii.edu/ (0 secs.)</pre>
  <pre>junit:</pre>
  <pre>BUILD SUCCESSFUL
Total time: 6 seconds</pre>
  <h2>D. User documentation</h2>
  <p>User-level documentation for this package is not available. The stack
  system is intended for developer use only.</p>


<h2>E. Developer documentation</h2>

<p>This distribution includes Eclipse project definition files. In addition, it
includes the following developer build files and targets. For the external tools
(JUnit, Abott), you must download them from their home
pages, unzip them, and then set an environment variable (JUNIT_HOME, etc.) to point to this directory.&nbsp;</p>

<table border="1" width="100%">
  <tr>
    <td width="22%" valign="top">junit.build.xml
      <p>Requires: JUnit 4.1</td>
    <td width="78%" valign="top">Runs <a href="http://www.junit.org/">JUnit</a>
      on the system, using Test case code in src/**/Test*.java.
      <p>Invocation: ant -f junit.build.xml</td>
  </tr>
  <tr>
    <td width="22%" valign="top">abott.build.xml</td>
    <td width="78%" valign="top">Runs <a href="http://sourceforge.net/projects/abbot">Abbot</a> on the system, using Test case code in src/**/Test*.java.
      <p>Invocation: ant -f abbot.build.xml</td>
  </tr>
</table>
  <h2>F. Contact information</h2>
  <p>If you would like to know more about this software, or would like to be
  informed of future releases:</p>
  <ul>
    <li><b>Home page</b>:&nbsp; <a href="http://csdl.ics.hawaii.edu/~johnson/413f06">http://csdl.ics.hawaii.edu/~johnson/413f06</a></li>
    <li><b>Developer contact:</b><a href="gy@hawaii.edu">Guanghong Yang</a> &amp; <a href="olkov@hawaii.edu">Alexey Olkov</a></li>
    <li><b>Configuration management repository:</b> not available.</li>
    <li><b>Developer and user mailing lists:</b> not available.</li>
  </ul>
<pre>&nbsp;</pre>

</body>
</html>
